@yarnpkg/libzip

What is @yarnpkg/libzip?

@yarnpkg/libzip is a library that provides functionalities for working with ZIP archives. It is part of the Yarn package manager's ecosystem and allows for creating, reading, and manipulating ZIP files programmatically.

What are @yarnpkg/libzip's main functionalities?

Creating a ZIP Archive

This code demonstrates how to create a ZIP archive and add a file to it using @yarnpkg/libzip. The `makeInterface` function initializes the libzip interface, and `ZipFS` is used to create and manipulate the ZIP file.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');

(async () => {
  const libzip = await makeInterface();
  const zipFs = new ZipFS(null, { libzip });

  zipFs.writeFileSync('/file.txt', 'Hello, world!');
  zipFs.saveAndClose();
})();

Reading a ZIP Archive

This code demonstrates how to read a ZIP archive and extract a file's content using @yarnpkg/libzip. The ZIP file is read from the filesystem, and `ZipFS` is used to access and read the file within the archive.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');
const fs = require('fs');

(async () => {
  const libzip = await makeInterface();
  const zipData = fs.readFileSync('archive.zip');
  const zipFs = new ZipFS(zipData, { libzip });

  const content = zipFs.readFileSync('/file.txt', 'utf8');
  console.log(content); // Outputs: Hello, world!
})();

Listing Files in a ZIP Archive

This code demonstrates how to list all files in a ZIP archive using @yarnpkg/libzip. The ZIP file is read from the filesystem, and `ZipFS` is used to list the files within the archive.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');
const fs = require('fs');

(async () => {
  const libzip = await makeInterface();
  const zipData = fs.readFileSync('archive.zip');
  const zipFs = new ZipFS(zipData, { libzip });

  const files = zipFs.readdirSync('/');
  console.log(files); // Outputs: ['file.txt']
})();

Other packages similar to @yarnpkg/libzip

adm-zip

ADM-ZIP is a pure JavaScript implementation for ZIP file handling. It provides similar functionalities to @yarnpkg/libzip, such as creating, reading, and extracting ZIP files. ADM-ZIP is widely used and has a straightforward API, making it a good alternative for ZIP file manipulation.

jszip

JSZip is a library for creating, reading, and editing .zip files with a JavaScript API. It is highly popular and well-documented, offering a range of features similar to @yarnpkg/libzip. JSZip is known for its ease of use and compatibility with both Node.js and browser environments.

node-stream-zip

node-stream-zip is a library for working with ZIP archives in a streaming manner. It allows for efficient reading and extraction of large ZIP files without loading the entire archive into memory. This makes it a good choice for handling large ZIP files compared to @yarnpkg/libzip.

README

@yarnpkg/libzip

This package contains a wasm-compiled version of the libzip.

Upgrade the libzip build

• Bump the version numbers in artifacts/build.sh
• Run the artifacts/build.sh script

Expose new functions

• Add the new functions to artifacts/exported.json
• List them in sources/index.ts
• Run the artifacts/build.sh script

Changelog

3.1.0

Commands

• The yarn workspaces list and yarn workspaces foreach commands now both support a new --since option that lets you filter the workspace list by changes (only workspaces that changed since the specified commit will be iterated on). This feature is still a little experimental, especially when used with -R,--recursive.
• The yarn workspaces foreach command now handles the fact that a script containing : only becomes global if it exists in exactly one workspace.
• The yarn workspaces foreach command now supports --jobs 1 and --jobs unlimited.
• The yarn init -2 command will now add the packageManager field to your project manifest.

Settings

• The pattern matcher from logFilters will now match any part of the log entry.

Installs

• A new nodeLinker: pnpm mode will let you install packages using the pnpm install strategy, where packages are stored flat and referenced by each others through symlinks. This mode is still a little experimental, so please send our way bugs you might find.
• Yarn won't install anymore packages that don't match the current OS. Should you need to (for example if you check-in your cache), use the supportedArchitectures field to manually enforce the presence of specific architectures.
• The nmMode: hardlinks-global setting will now be automatically downgraded to nmMode: hardlinks-local when global caches and install folders are kept on different devices, thus letting the install continue normally. A warning will still be produced explaining this behaviour.
• The node_modules linker maximizes chances to end-up with only one top-level node_modules in the case of using workspaces
• The nmSelfReferences setting has been added to the nm linker to control whether workspaces are allowed to require themselves - results in creation of self-referencing symlinks. yarn workspaces focus will not create self-referencing symlinks for excluded workspaces anymore.
• Yarn can now install workspaces from remote git repositories that use npm if npm@>=7.x is installed on the system.
• The hoisting algorithm should be faster, improving the install time for recurrent node_modules installs.

Miscellaneous Features

• Workspaces can now be referred to using workspace:^ and workspace:~. When published, those markers will turn into the actual version (just like what used to happen with workspace:*), except that they'll be prefixed with the relevant semver prefix (respectively ^ and ~).
• A new npmAuditRegistry setting will let you define which registry to use when running audits. If unset, we'll fallback to the currently configured publish registry (we'll likely change this behavior in Yarn 4 to rather use the fetch registry).

Bugfixes

• Direct portal dependencies for node_modules installs will now be given priority during hoisting, preventing cases when indirect regular dependencies would block the way for direct portal dependencies.
• The pnpify binary can now be used from inside directories containing spaces.
• The CLI bundles built from sources will now output the commit hash instead of the tree hash, as part of their --version string.
• Nested workspaces are properly hoisted by node-modules linker.
• Self-referencing symlinks won't be created for anonymous workspaces when using the node-modules linker, since they cannot be used from the code anyway.
• The cache is now fully atomic when moving files across devices, and is more efficient in general.
• The PnP patch will now properly pick up changes to the fs module, allowing users to patch it.
• When using PnP, require.resolve('pnpapi') will be handled correctly even when using exports.
• The install state will no longer be invalidated after running commands that modify the lockfile; this should bring a significant performance improvement when running commands such as yarn run immediately after adding or removing dependencies inside large monorepos.
• Optional peer dependencies now imply an optional peer dependency on the corresponding @types version. This matches the behaviour for peer dependencies.

Compatibility

• Yarn will now generate an experimental ESM loader when it detects you may need it. This can be disabled (or enabled) using pnpEnableEsmLoader.
• The PnP compatibility patch for resolve will no longer resolve missing modules to a file with the same name that would happen to be located next to the issuer.
• Fixes the SDK to account for a breaking change in VSCode >=1.61.